<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>LibCDS: /home/zsshen/Desktop/git-hub-code/C-Common-Data-Structures/include/container/vector.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">LibCDS
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>Globals</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('vector_8h_source.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">vector.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="vector_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * @file vector.h The dynamically growable array.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;</div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="preprocessor">#ifndef _VECTOR_H_</span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define _VECTOR_H_</span></div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="preprocessor">#include &quot;../util.h&quot;</span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment">/** VectorData is the data type for the container private information. */</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"><a class="line" href="vector_8h.html#ae7e1bc0ebd3e2d9616179a88c660aafe">   11</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span>_VectorData <a class="code" href="vector_8h.html#ae7e1bc0ebd3e2d9616179a88c660aafe">VectorData</a>;</div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment">/** The implementation for dynamically growable array. */</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"><a class="line" href="structVector.html">   14</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span>_Vector {<span class="comment"></span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment">    /** The container private information */</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="structVector.html#a35aae525dbdc881fb419a091a2fb2606">   16</a></span>&#160;    <a class="code" href="vector_8h.html#ae7e1bc0ebd3e2d9616179a88c660aafe">VectorData</a> *<a class="code" href="structVector.html#a35aae525dbdc881fb419a091a2fb2606">pData</a>;</div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment">    /** Push an item to the tail of the vector.</span></div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment">        @see VectorPushBack */</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="structVector.html#a1c7f7e1ba87e66c1952a47490f3452e1">   20</a></span>&#160;    int32_t (*push_back) (<span class="keyword">struct </span>_Vector*, Item);</div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment">    /** Insert an item to the designated index of the vector.</span></div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="comment">        @see VectorInsert */</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="structVector.html#a661e11a387e7194b48fc222f9d812710">   24</a></span>&#160;    int32_t (*insert) (<span class="keyword">struct </span>_Vector*, Item, int32_t);</div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="comment">    /** Pop an item from the tail of the vector.</span></div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="comment">        @see VectorPopBack */</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="structVector.html#a8ef205b5ab3ff9e9f50aa4f3c3864475">   28</a></span>&#160;    int32_t (*pop_back) (<span class="keyword">struct </span>_Vector*);</div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="comment">    /** Delete an item from the designated index of the vector.</span></div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="comment">        @see VectorDelete */</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="structVector.html#a75080f59c207d9c609b2212b753412a9">   32</a></span>&#160;    int32_t (*<span class="keyword">delete</span>) (<span class="keyword">struct </span>_Vector*, int32_t);</div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="comment">    /** Set an item at the designated index of the vector.</span></div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="comment">        @see VectorSet */</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="structVector.html#a1792ba516f985c7542f0ba9271a6b6b8">   36</a></span>&#160;    int32_t (*set) (<span class="keyword">struct </span>_Vector*, Item, int32_t);</div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="comment">    /** Get an item from the designated index of the vector.</span></div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;<span class="comment">        @see VectorGet */</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="structVector.html#a5ed5012dce5b27cb4e7b560af3c99497">   40</a></span>&#160;    int32_t (*<span class="keyword">get</span>) (<span class="keyword">struct </span>_Vector*, Item*, int32_t);</div>
<div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;<span class="comment">    /** Change the container capacity.</span></div>
<div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;<span class="comment">        @see VectorResize */</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="structVector.html#a22553ac3a370b6e8328d182f25cef754">   44</a></span>&#160;    int32_t (*resize) (<span class="keyword">struct </span>_Vector*, int32_t);</div>
<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;<span class="comment">    /** Return the number of stored items.</span></div>
<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;<span class="comment">        @see VectorSize */</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="structVector.html#a3eb2a573613cac32770be7043b02f220">   48</a></span>&#160;    int32_t (*size) (<span class="keyword">struct </span>_Vector*);</div>
<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;<span class="comment">    /** Return the container capacity.</span></div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;<span class="comment">        @see VectorCapacity */</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="structVector.html#ad21bb9cf79b2768c70ed28c7a8a7ea20">   52</a></span>&#160;    int32_t (*capacity) (<span class="keyword">struct </span>_Vector*);</div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;<span class="comment">    /** Sort the items via the designated item comparison method.</span></div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;<span class="comment">        @see VectorSort */</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="structVector.html#af91da4c730d25e51d26cebe13593f221">   56</a></span>&#160;    int32_t (*sort) (<span class="keyword">struct </span>_Vector*, int32_t (*) (<span class="keyword">const</span> <span class="keywordtype">void</span>*, <span class="keyword">const</span> <span class="keywordtype">void</span>*));</div>
<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;<span class="comment">    /** Iterate through the vector till the tail end.</span></div>
<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;<span class="comment">        @see VectorIterate */</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="structVector.html#a3260bc1b27debed9cfb48dba07266d42">   60</a></span>&#160;    int32_t (*iterate) (<span class="keyword">struct </span>_Vector*, bool, Item*);</div>
<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;<span class="comment">    /** Reversely iterate through the vector till the head end.</span></div>
<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;<span class="comment">        @see VectorReverseIterate */</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="structVector.html#a1ee0dafd93fec74bcf4883c1a9a95f93">   64</a></span>&#160;    int32_t (*reverse_iterate) (<span class="keyword">struct </span>_Vector*, bool, Item*);</div>
<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;<span class="comment">    /** Set the custom item resource clean method.</span></div>
<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;<span class="comment">        @see VectorSetDestroy */</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="structVector.html#a1ca022cb083b7237760bd52269f86e88">   68</a></span>&#160;    int32_t (*set_destroy) (<span class="keyword">struct </span>_Vector*, void (*) (Item));</div>
<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;} <a class="code" href="structVector.html">Vector</a>;</div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;</div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;</div>
<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;<span class="comment">/*===========================================================================*</span></div>
<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;<span class="comment"> *             Definition for the exported member operations                 *</span></div>
<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;<span class="comment"> *===========================================================================*/</span><span class="comment"></span></div>
<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;<span class="comment"> * @brief The constructor for Vector.</span></div>
<div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;<span class="comment"> * @param ppObj         The double pointer to the to be constructed vector</span></div>
<div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;<span class="comment"> * @param iCap          The designated initial capacity</span></div>
<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;<span class="comment"> * @retval SUCC</span></div>
<div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;<span class="comment"> * @retval ERR_NOMEM    Insufficient memory for vector construction</span></div>
<div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;<span class="comment"> * @note Specify iCap to 0 for default initial capacity.</span></div>
<div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;int32_t <a class="code" href="vector_8h.html#aee13af756ae9331b7cffd5915608d988">VectorInit</a>(<a class="code" href="structVector.html">Vector</a> **ppObj, int32_t iCap);</div>
<div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;<span class="comment"> * @brief The destructor for Vector.</span></div>
<div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;<span class="comment"> * If the custom resource clean method is set, it also runs the clean method for</span></div>
<div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;<span class="comment"> * all the items.</span></div>
<div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;<span class="comment"> * @param ppObj         The double pointer to the to be destructed vector</span></div>
<div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;<span class="keywordtype">void</span> <a class="code" href="vector_8h.html#a55d4d7d2f5dfee1f7b25fd7c92d22f27">VectorDeinit</a>(<a class="code" href="structVector.html">Vector</a> **ppObj);</div>
<div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;<span class="comment"> * @brief Push an item to the tail of the vector.</span></div>
<div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;<span class="comment"> * This function pushes an item to the tail of the vector with the corresponding</span></div>
<div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;<span class="comment"> * vector size extension. If the storage is full, the space reallocation is</span></div>
<div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;<span class="comment"> * automatically triggered to store the newly pushed item.</span></div>
<div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;<span class="comment"> * @param self          The pointer to the Vector structure</span></div>
<div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;<span class="comment"> * @param item          The designated item</span></div>
<div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;<span class="comment"> * @retval SUCC</span></div>
<div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;<span class="comment"> * @retval ERR_NOMEM    Insufficient memory for vector extension</span></div>
<div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;int32_t <a class="code" href="vector_8h.html#a7c4fa1c894e411db9c05639c3062a985">VectorPushBack</a>(<a class="code" href="structVector.html">Vector</a> *<span class="keyword">self</span>, Item item);</div>
<div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;<span class="comment"> * @brief Insert an item to the designated index of the vector.</span></div>
<div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;<span class="comment"> * This function inserts an item to the designated index of the vector and shifts</span></div>
<div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;<span class="comment"> * the trailing items one position to the tail. Naturally, the vector size is extended.</span></div>
<div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;<span class="comment"> * And if the storage is full, the space reallocation is automatically triggered</span></div>
<div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;<span class="comment"> * to store the newly inserted item.</span></div>
<div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;<span class="comment"> * @param self          The pointer to the Vector structure</span></div>
<div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;<span class="comment"> * @param item          The designated item</span></div>
<div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;<span class="comment"> * @param iIdx          The designated index</span></div>
<div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;<span class="comment"> * @retval SUCC</span></div>
<div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;<span class="comment"> * @retval ERR_IDX      Illegal index</span></div>
<div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;<span class="comment"> * @note The designated index should be equal to or smaller than the vector</span></div>
<div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;<span class="comment"> * size and should not be negative. If the index is equal to the vector size,</span></div>
<div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;<span class="comment"> * the effect is equivalent to push_back().</span></div>
<div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00134"></a><span class="lineno">  134</span>&#160;int32_t <a class="code" href="vector_8h.html#a67e0f39d32d550ce592ace927d496c3b">VectorInsert</a>(<a class="code" href="structVector.html">Vector</a> *<span class="keyword">self</span>, Item item, int32_t iIdx);</div>
<div class="line"><a name="l00135"></a><span class="lineno">  135</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00136"></a><span class="lineno">  136</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00137"></a><span class="lineno">  137</span>&#160;<span class="comment"> * @brief Pop an item from the tail of the vector.</span></div>
<div class="line"><a name="l00138"></a><span class="lineno">  138</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00139"></a><span class="lineno">  139</span>&#160;<span class="comment"> * This function removes an item from the tail of the vector. If the custom</span></div>
<div class="line"><a name="l00140"></a><span class="lineno">  140</span>&#160;<span class="comment"> * resource clean method is set, it also runs the clean method for the removed</span></div>
<div class="line"><a name="l00141"></a><span class="lineno">  141</span>&#160;<span class="comment"> * item. Naturally, the vector size is shrunk.</span></div>
<div class="line"><a name="l00142"></a><span class="lineno">  142</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00143"></a><span class="lineno">  143</span>&#160;<span class="comment"> * @param self          The pointer to the Vector structure</span></div>
<div class="line"><a name="l00144"></a><span class="lineno">  144</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00145"></a><span class="lineno">  145</span>&#160;<span class="comment"> * @retval SUCC</span></div>
<div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00147"></a><span class="lineno">  147</span>&#160;<span class="comment"> * @retval ERR_IDX      Empty vector</span></div>
<div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00149"></a><span class="lineno">  149</span>&#160;int32_t <a class="code" href="vector_8h.html#a99ccfafe2c7578449c30ac36ee5ea85b">VectorPopBack</a>(<a class="code" href="structVector.html">Vector</a> *<span class="keyword">self</span>);</div>
<div class="line"><a name="l00150"></a><span class="lineno">  150</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00151"></a><span class="lineno">  151</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00152"></a><span class="lineno">  152</span>&#160;<span class="comment"> * @brief Delete an item from the designated index of the vector.</span></div>
<div class="line"><a name="l00153"></a><span class="lineno">  153</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00154"></a><span class="lineno">  154</span>&#160;<span class="comment"> * This function removes an item from the designated index of the vector and shifts</span></div>
<div class="line"><a name="l00155"></a><span class="lineno">  155</span>&#160;<span class="comment"> * the trailing items one position to the head. If the custom resource clean</span></div>
<div class="line"><a name="l00156"></a><span class="lineno">  156</span>&#160;<span class="comment"> * method is set, it also runs the clean method for the removed item. Naturally,</span></div>
<div class="line"><a name="l00157"></a><span class="lineno">  157</span>&#160;<span class="comment"> * the vector size is shrunk.</span></div>
<div class="line"><a name="l00158"></a><span class="lineno">  158</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00159"></a><span class="lineno">  159</span>&#160;<span class="comment"> * @param self          The pointer to the Vector structure</span></div>
<div class="line"><a name="l00160"></a><span class="lineno">  160</span>&#160;<span class="comment"> * @param iIdx          The designated index</span></div>
<div class="line"><a name="l00161"></a><span class="lineno">  161</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00162"></a><span class="lineno">  162</span>&#160;<span class="comment"> * @retval SUCC</span></div>
<div class="line"><a name="l00163"></a><span class="lineno">  163</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00164"></a><span class="lineno">  164</span>&#160;<span class="comment"> * @retval ERR_IDX      Illegal index</span></div>
<div class="line"><a name="l00165"></a><span class="lineno">  165</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00166"></a><span class="lineno">  166</span>&#160;<span class="comment"> * @note The designated index should be smaller than the vector size and</span></div>
<div class="line"><a name="l00167"></a><span class="lineno">  167</span>&#160;<span class="comment"> * should not be negative. If the index is equal to the vector size minus one,</span></div>
<div class="line"><a name="l00168"></a><span class="lineno">  168</span>&#160;<span class="comment"> * the operation is equivalent to pop_back().</span></div>
<div class="line"><a name="l00169"></a><span class="lineno">  169</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00170"></a><span class="lineno">  170</span>&#160;int32_t <a class="code" href="vector_8h.html#a8e3f2e20699db4db95b6b3eea78699f9">VectorDelete</a>(<a class="code" href="structVector.html">Vector</a> *<span class="keyword">self</span>, int32_t iIdx);</div>
<div class="line"><a name="l00171"></a><span class="lineno">  171</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00172"></a><span class="lineno">  172</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00173"></a><span class="lineno">  173</span>&#160;<span class="comment"> * @brief Set an item at the designated index of the vector.</span></div>
<div class="line"><a name="l00174"></a><span class="lineno">  174</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00175"></a><span class="lineno">  175</span>&#160;<span class="comment"> * This function replaces an item at the designated index of the vector. If the</span></div>
<div class="line"><a name="l00176"></a><span class="lineno">  176</span>&#160;<span class="comment"> * custom resource clean method is set, it also runs the clean method for the</span></div>
<div class="line"><a name="l00177"></a><span class="lineno">  177</span>&#160;<span class="comment"> * replaced item.</span></div>
<div class="line"><a name="l00178"></a><span class="lineno">  178</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00179"></a><span class="lineno">  179</span>&#160;<span class="comment"> * @param self          The pointer to the Vector structure</span></div>
<div class="line"><a name="l00180"></a><span class="lineno">  180</span>&#160;<span class="comment"> * @param item          The designated item</span></div>
<div class="line"><a name="l00181"></a><span class="lineno">  181</span>&#160;<span class="comment"> * @param iIdx          The designated index</span></div>
<div class="line"><a name="l00182"></a><span class="lineno">  182</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00183"></a><span class="lineno">  183</span>&#160;<span class="comment"> * @retval SUCC</span></div>
<div class="line"><a name="l00184"></a><span class="lineno">  184</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00185"></a><span class="lineno">  185</span>&#160;<span class="comment"> * @retval ERR_IDX      Illegal index</span></div>
<div class="line"><a name="l00186"></a><span class="lineno">  186</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00187"></a><span class="lineno">  187</span>&#160;<span class="comment"> * @note The designated index should be smaller than the vector size and should</span></div>
<div class="line"><a name="l00188"></a><span class="lineno">  188</span>&#160;<span class="comment"> * not be negative.</span></div>
<div class="line"><a name="l00189"></a><span class="lineno">  189</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00190"></a><span class="lineno">  190</span>&#160;int32_t <a class="code" href="vector_8h.html#a04e4098bc20098fba01e057db43549a3">VectorSet</a>(<a class="code" href="structVector.html">Vector</a> *<span class="keyword">self</span>, Item item, int32_t iIdx);</div>
<div class="line"><a name="l00191"></a><span class="lineno">  191</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00192"></a><span class="lineno">  192</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00193"></a><span class="lineno">  193</span>&#160;<span class="comment"> * @brief Get an item from the designated index of the vector.</span></div>
<div class="line"><a name="l00194"></a><span class="lineno">  194</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00195"></a><span class="lineno">  195</span>&#160;<span class="comment"> * This function retrieves an item from the designated index of the vector. If</span></div>
<div class="line"><a name="l00196"></a><span class="lineno">  196</span>&#160;<span class="comment"> * the index is illegal, the error code is returned and the second parameter is</span></div>
<div class="line"><a name="l00197"></a><span class="lineno">  197</span>&#160;<span class="comment"> * also updated with NULL.</span></div>
<div class="line"><a name="l00198"></a><span class="lineno">  198</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00199"></a><span class="lineno">  199</span>&#160;<span class="comment"> * @param self          The pointer to the Vector structure</span></div>
<div class="line"><a name="l00200"></a><span class="lineno">  200</span>&#160;<span class="comment"> * @param pItem         The pointer to the returned item</span></div>
<div class="line"><a name="l00201"></a><span class="lineno">  201</span>&#160;<span class="comment"> * @param iIdx          The designated index</span></div>
<div class="line"><a name="l00202"></a><span class="lineno">  202</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00203"></a><span class="lineno">  203</span>&#160;<span class="comment"> * @retval SUCC</span></div>
<div class="line"><a name="l00204"></a><span class="lineno">  204</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00205"></a><span class="lineno">  205</span>&#160;<span class="comment"> * @retval ERR_IDX      Illegal index</span></div>
<div class="line"><a name="l00206"></a><span class="lineno">  206</span>&#160;<span class="comment"> * @retval ERR_GET      Invalid parameter to store returned item</span></div>
<div class="line"><a name="l00207"></a><span class="lineno">  207</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00208"></a><span class="lineno">  208</span>&#160;<span class="comment"> * @note The designated index should be smaller than the vector size and should</span></div>
<div class="line"><a name="l00209"></a><span class="lineno">  209</span>&#160;<span class="comment"> * not be negative.</span></div>
<div class="line"><a name="l00210"></a><span class="lineno">  210</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00211"></a><span class="lineno">  211</span>&#160;int32_t <a class="code" href="vector_8h.html#ad69c5de92277cdb34fd3a5476ef18e08">VectorGet</a>(<a class="code" href="structVector.html">Vector</a> *<span class="keyword">self</span>, Item *pItem, int32_t iIdx);</div>
<div class="line"><a name="l00212"></a><span class="lineno">  212</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00213"></a><span class="lineno">  213</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00214"></a><span class="lineno">  214</span>&#160;<span class="comment"> * @brief Change the container capacity.</span></div>
<div class="line"><a name="l00215"></a><span class="lineno">  215</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00216"></a><span class="lineno">  216</span>&#160;<span class="comment"> * This function resizes the storage capacity. If the new capacity is smaller</span></div>
<div class="line"><a name="l00217"></a><span class="lineno">  217</span>&#160;<span class="comment"> * than the old size. The trailing items will be removed. If the custom resource</span></div>
<div class="line"><a name="l00218"></a><span class="lineno">  218</span>&#160;<span class="comment"> * clean method is set, it also runs the clean method for the removed items.</span></div>
<div class="line"><a name="l00219"></a><span class="lineno">  219</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00220"></a><span class="lineno">  220</span>&#160;<span class="comment"> * @param self          The pointer to the Vector structure</span></div>
<div class="line"><a name="l00221"></a><span class="lineno">  221</span>&#160;<span class="comment"> * @param iCap          The designated capacity</span></div>
<div class="line"><a name="l00222"></a><span class="lineno">  222</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00223"></a><span class="lineno">  223</span>&#160;<span class="comment"> * @retval SUCC</span></div>
<div class="line"><a name="l00224"></a><span class="lineno">  224</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00225"></a><span class="lineno">  225</span>&#160;<span class="comment"> * @retval ERR_NOMEM   Insufficient memory for vector extension</span></div>
<div class="line"><a name="l00226"></a><span class="lineno">  226</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00227"></a><span class="lineno">  227</span>&#160;<span class="comment"> * @note The designated capacity should greater than zero.</span></div>
<div class="line"><a name="l00228"></a><span class="lineno">  228</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00229"></a><span class="lineno">  229</span>&#160;int32_t <a class="code" href="vector_8h.html#a6f8dc6d9ab0a790c66acec7340dcd118">VectorResize</a>(<a class="code" href="structVector.html">Vector</a> *<span class="keyword">self</span>, int32_t iCap);</div>
<div class="line"><a name="l00230"></a><span class="lineno">  230</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00231"></a><span class="lineno">  231</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00232"></a><span class="lineno">  232</span>&#160;<span class="comment"> * @brief Return the number of stored items.</span></div>
<div class="line"><a name="l00233"></a><span class="lineno">  233</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00234"></a><span class="lineno">  234</span>&#160;<span class="comment"> * @param self          The pointer to the Vector structure</span></div>
<div class="line"><a name="l00235"></a><span class="lineno">  235</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00236"></a><span class="lineno">  236</span>&#160;<span class="comment"> * @return              The number of stored items</span></div>
<div class="line"><a name="l00237"></a><span class="lineno">  237</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00238"></a><span class="lineno">  238</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00239"></a><span class="lineno">  239</span>&#160;int32_t <a class="code" href="vector_8h.html#a3d6adfa3c82db3a3d14d96ae5aa0f941">VectorSize</a>(<a class="code" href="structVector.html">Vector</a> *<span class="keyword">self</span>);</div>
<div class="line"><a name="l00240"></a><span class="lineno">  240</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00241"></a><span class="lineno">  241</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00242"></a><span class="lineno">  242</span>&#160;<span class="comment"> * @brief Return the container capacity.</span></div>
<div class="line"><a name="l00243"></a><span class="lineno">  243</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00244"></a><span class="lineno">  244</span>&#160;<span class="comment"> * @param self          The pointer to the Vector structure</span></div>
<div class="line"><a name="l00245"></a><span class="lineno">  245</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00246"></a><span class="lineno">  246</span>&#160;<span class="comment"> * @return              The container capacity</span></div>
<div class="line"><a name="l00247"></a><span class="lineno">  247</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00248"></a><span class="lineno">  248</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00249"></a><span class="lineno">  249</span>&#160;int32_t <a class="code" href="vector_8h.html#aebe9767f9216efa7efcd5d006ea47009">VectorCapacity</a>(<a class="code" href="structVector.html">Vector</a> *<span class="keyword">self</span>);</div>
<div class="line"><a name="l00250"></a><span class="lineno">  250</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00251"></a><span class="lineno">  251</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00252"></a><span class="lineno">  252</span>&#160;<span class="comment"> * @brief Sort the items via the designated item comparison method.</span></div>
<div class="line"><a name="l00253"></a><span class="lineno">  253</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00254"></a><span class="lineno">  254</span>&#160;<span class="comment"> * @param self          The pointer to the Vector structure</span></div>
<div class="line"><a name="l00255"></a><span class="lineno">  255</span>&#160;<span class="comment"> * @param pFunc         The function pointer to the custom method</span></div>
<div class="line"><a name="l00256"></a><span class="lineno">  256</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00257"></a><span class="lineno">  257</span>&#160;<span class="comment"> * @retval SUCC</span></div>
<div class="line"><a name="l00258"></a><span class="lineno">  258</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00259"></a><span class="lineno">  259</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00260"></a><span class="lineno">  260</span>&#160;int32_t <a class="code" href="vector_8h.html#aa3a8d94d6fffaf20d61dd713d2bf84fd">VectorSort</a>(<a class="code" href="structVector.html">Vector</a> *<span class="keyword">self</span>, int32_t (*pFunc) (<span class="keyword">const</span> <span class="keywordtype">void</span>*, <span class="keyword">const</span> <span class="keywordtype">void</span>*));</div>
<div class="line"><a name="l00261"></a><span class="lineno">  261</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00262"></a><span class="lineno">  262</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00263"></a><span class="lineno">  263</span>&#160;<span class="comment"> * @brief Iterate through the vector till the tail end.</span></div>
<div class="line"><a name="l00264"></a><span class="lineno">  264</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00265"></a><span class="lineno">  265</span>&#160;<span class="comment"> * Before iterating through the vector, it is necessary to pass bReset := true and</span></div>
<div class="line"><a name="l00266"></a><span class="lineno">  266</span>&#160;<span class="comment"> * pItem := NULL for iterator initialization.</span></div>
<div class="line"><a name="l00267"></a><span class="lineno">  267</span>&#160;<span class="comment"> * After initialization, you can pass bReset := false and pItem := the relevant</span></div>
<div class="line"><a name="l00268"></a><span class="lineno">  268</span>&#160;<span class="comment"> * pointer to get the returned item at each iteration.</span></div>
<div class="line"><a name="l00269"></a><span class="lineno">  269</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00270"></a><span class="lineno">  270</span>&#160;<span class="comment"> * @param self          The pointer to the Vector structure</span></div>
<div class="line"><a name="l00271"></a><span class="lineno">  271</span>&#160;<span class="comment"> * @param bReset        The knob to reset the iteration</span></div>
<div class="line"><a name="l00272"></a><span class="lineno">  272</span>&#160;<span class="comment"> * @param pItem         The pointer to the returned item</span></div>
<div class="line"><a name="l00273"></a><span class="lineno">  273</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00274"></a><span class="lineno">  274</span>&#160;<span class="comment"> * @retval SUCC</span></div>
<div class="line"><a name="l00275"></a><span class="lineno">  275</span>&#160;<span class="comment"> * @retval END          At the tail end of the vector</span></div>
<div class="line"><a name="l00276"></a><span class="lineno">  276</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00277"></a><span class="lineno">  277</span>&#160;<span class="comment"> * @retval ERR_GET      Invalid parameter to store returned item</span></div>
<div class="line"><a name="l00278"></a><span class="lineno">  278</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00279"></a><span class="lineno">  279</span>&#160;int32_t <a class="code" href="vector_8h.html#a3f8bbcf02e7f5e6bd975aa87a0f0ea21">VectorIterate</a>(<a class="code" href="structVector.html">Vector</a> *<span class="keyword">self</span>, <span class="keywordtype">bool</span> bReset, Item *pItem);</div>
<div class="line"><a name="l00280"></a><span class="lineno">  280</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00281"></a><span class="lineno">  281</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00282"></a><span class="lineno">  282</span>&#160;<span class="comment"> * @brief Reversely iterate through the vector till the head end.</span></div>
<div class="line"><a name="l00283"></a><span class="lineno">  283</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00284"></a><span class="lineno">  284</span>&#160;<span class="comment"> * Before reversely iterating through the vector, it is necessary to pass</span></div>
<div class="line"><a name="l00285"></a><span class="lineno">  285</span>&#160;<span class="comment"> * bReset := true and pItem := NULL for iterator initialization.</span></div>
<div class="line"><a name="l00286"></a><span class="lineno">  286</span>&#160;<span class="comment"> * After initialization, you can pass bReset := false and pItem := the relevant</span></div>
<div class="line"><a name="l00287"></a><span class="lineno">  287</span>&#160;<span class="comment"> * pointer to get the returned item at each iteration.</span></div>
<div class="line"><a name="l00288"></a><span class="lineno">  288</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00289"></a><span class="lineno">  289</span>&#160;<span class="comment"> * @param self          The pointer to the Vector structure</span></div>
<div class="line"><a name="l00290"></a><span class="lineno">  290</span>&#160;<span class="comment"> * @param bReset        The knob to reset the iteration</span></div>
<div class="line"><a name="l00291"></a><span class="lineno">  291</span>&#160;<span class="comment"> * @param pItem         The pointer to the returned item</span></div>
<div class="line"><a name="l00292"></a><span class="lineno">  292</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00293"></a><span class="lineno">  293</span>&#160;<span class="comment"> * @retval SUCC</span></div>
<div class="line"><a name="l00294"></a><span class="lineno">  294</span>&#160;<span class="comment"> * @retval END          At the tail end of the vector</span></div>
<div class="line"><a name="l00295"></a><span class="lineno">  295</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00296"></a><span class="lineno">  296</span>&#160;<span class="comment"> * @retval ERR_GET      Invalid parameter to store returned item</span></div>
<div class="line"><a name="l00297"></a><span class="lineno">  297</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00298"></a><span class="lineno">  298</span>&#160;int32_t <a class="code" href="vector_8h.html#a010ad24d57d84416859b3f2bc928056c">VectorReverseIterate</a>(<a class="code" href="structVector.html">Vector</a> *<span class="keyword">self</span>, <span class="keywordtype">bool</span> bReset, Item *pItem);</div>
<div class="line"><a name="l00299"></a><span class="lineno">  299</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00300"></a><span class="lineno">  300</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00301"></a><span class="lineno">  301</span>&#160;<span class="comment"> * @brief Set the custom item resource clean method.</span></div>
<div class="line"><a name="l00302"></a><span class="lineno">  302</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00303"></a><span class="lineno">  303</span>&#160;<span class="comment"> * @param self          The pointer to the Vector structure</span></div>
<div class="line"><a name="l00304"></a><span class="lineno">  304</span>&#160;<span class="comment"> * @param pFunc         The function pointer to the custom method</span></div>
<div class="line"><a name="l00305"></a><span class="lineno">  305</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00306"></a><span class="lineno">  306</span>&#160;<span class="comment"> * @retval SUCC</span></div>
<div class="line"><a name="l00307"></a><span class="lineno">  307</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00308"></a><span class="lineno">  308</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00309"></a><span class="lineno">  309</span>&#160;int32_t <a class="code" href="vector_8h.html#a6ae446f90b85e646fa3dd6e515afe0f9">VectorSetDestroy</a>(<a class="code" href="structVector.html">Vector</a> *<span class="keyword">self</span>, <span class="keywordtype">void</span> (*pFunc) (Item));</div>
<div class="line"><a name="l00310"></a><span class="lineno">  310</span>&#160;</div>
<div class="line"><a name="l00311"></a><span class="lineno">  311</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="vector_8h_html_a67e0f39d32d550ce592ace927d496c3b"><div class="ttname"><a href="vector_8h.html#a67e0f39d32d550ce592ace927d496c3b">VectorInsert</a></div><div class="ttdeci">int32_t VectorInsert(Vector *self, Item item, int32_t iIdx)</div><div class="ttdoc">Insert an item to the designated index of the vector. </div></div>
<div class="ttc" id="vector_8h_html_a55d4d7d2f5dfee1f7b25fd7c92d22f27"><div class="ttname"><a href="vector_8h.html#a55d4d7d2f5dfee1f7b25fd7c92d22f27">VectorDeinit</a></div><div class="ttdeci">void VectorDeinit(Vector **ppObj)</div><div class="ttdoc">The destructor for Vector. </div></div>
<div class="ttc" id="vector_8h_html_a8e3f2e20699db4db95b6b3eea78699f9"><div class="ttname"><a href="vector_8h.html#a8e3f2e20699db4db95b6b3eea78699f9">VectorDelete</a></div><div class="ttdeci">int32_t VectorDelete(Vector *self, int32_t iIdx)</div><div class="ttdoc">Delete an item from the designated index of the vector. </div></div>
<div class="ttc" id="vector_8h_html_a6ae446f90b85e646fa3dd6e515afe0f9"><div class="ttname"><a href="vector_8h.html#a6ae446f90b85e646fa3dd6e515afe0f9">VectorSetDestroy</a></div><div class="ttdeci">int32_t VectorSetDestroy(Vector *self, void(*pFunc)(Item))</div><div class="ttdoc">Set the custom item resource clean method. </div></div>
<div class="ttc" id="vector_8h_html_a3f8bbcf02e7f5e6bd975aa87a0f0ea21"><div class="ttname"><a href="vector_8h.html#a3f8bbcf02e7f5e6bd975aa87a0f0ea21">VectorIterate</a></div><div class="ttdeci">int32_t VectorIterate(Vector *self, bool bReset, Item *pItem)</div><div class="ttdoc">Iterate through the vector till the tail end. </div></div>
<div class="ttc" id="vector_8h_html_aa3a8d94d6fffaf20d61dd713d2bf84fd"><div class="ttname"><a href="vector_8h.html#aa3a8d94d6fffaf20d61dd713d2bf84fd">VectorSort</a></div><div class="ttdeci">int32_t VectorSort(Vector *self, int32_t(*pFunc)(const void *, const void *))</div><div class="ttdoc">Sort the items via the designated item comparison method. </div></div>
<div class="ttc" id="vector_8h_html_a7c4fa1c894e411db9c05639c3062a985"><div class="ttname"><a href="vector_8h.html#a7c4fa1c894e411db9c05639c3062a985">VectorPushBack</a></div><div class="ttdeci">int32_t VectorPushBack(Vector *self, Item item)</div><div class="ttdoc">Push an item to the tail of the vector. </div></div>
<div class="ttc" id="vector_8h_html_ae7e1bc0ebd3e2d9616179a88c660aafe"><div class="ttname"><a href="vector_8h.html#ae7e1bc0ebd3e2d9616179a88c660aafe">VectorData</a></div><div class="ttdeci">struct _VectorData VectorData</div><div class="ttdoc">VectorData is the data type for the container private information. </div><div class="ttdef"><b>Definition:</b> <a href="vector_8h_source.html#l00011">vector.h:11</a></div></div>
<div class="ttc" id="vector_8h_html_a99ccfafe2c7578449c30ac36ee5ea85b"><div class="ttname"><a href="vector_8h.html#a99ccfafe2c7578449c30ac36ee5ea85b">VectorPopBack</a></div><div class="ttdeci">int32_t VectorPopBack(Vector *self)</div><div class="ttdoc">Pop an item from the tail of the vector. </div></div>
<div class="ttc" id="structVector_html"><div class="ttname"><a href="structVector.html">Vector</a></div><div class="ttdoc">The implementation for dynamically growable array. </div><div class="ttdef"><b>Definition:</b> <a href="vector_8h_source.html#l00014">vector.h:14</a></div></div>
<div class="ttc" id="vector_8h_html_aee13af756ae9331b7cffd5915608d988"><div class="ttname"><a href="vector_8h.html#aee13af756ae9331b7cffd5915608d988">VectorInit</a></div><div class="ttdeci">int32_t VectorInit(Vector **ppObj, int32_t iCap)</div><div class="ttdoc">The constructor for Vector. </div></div>
<div class="ttc" id="vector_8h_html_a3d6adfa3c82db3a3d14d96ae5aa0f941"><div class="ttname"><a href="vector_8h.html#a3d6adfa3c82db3a3d14d96ae5aa0f941">VectorSize</a></div><div class="ttdeci">int32_t VectorSize(Vector *self)</div><div class="ttdoc">Return the number of stored items. </div></div>
<div class="ttc" id="vector_8h_html_a6f8dc6d9ab0a790c66acec7340dcd118"><div class="ttname"><a href="vector_8h.html#a6f8dc6d9ab0a790c66acec7340dcd118">VectorResize</a></div><div class="ttdeci">int32_t VectorResize(Vector *self, int32_t iCap)</div><div class="ttdoc">Change the container capacity. </div></div>
<div class="ttc" id="vector_8h_html_a010ad24d57d84416859b3f2bc928056c"><div class="ttname"><a href="vector_8h.html#a010ad24d57d84416859b3f2bc928056c">VectorReverseIterate</a></div><div class="ttdeci">int32_t VectorReverseIterate(Vector *self, bool bReset, Item *pItem)</div><div class="ttdoc">Reversely iterate through the vector till the head end. </div></div>
<div class="ttc" id="vector_8h_html_ad69c5de92277cdb34fd3a5476ef18e08"><div class="ttname"><a href="vector_8h.html#ad69c5de92277cdb34fd3a5476ef18e08">VectorGet</a></div><div class="ttdeci">int32_t VectorGet(Vector *self, Item *pItem, int32_t iIdx)</div><div class="ttdoc">Get an item from the designated index of the vector. </div></div>
<div class="ttc" id="structVector_html_a35aae525dbdc881fb419a091a2fb2606"><div class="ttname"><a href="structVector.html#a35aae525dbdc881fb419a091a2fb2606">Vector::pData</a></div><div class="ttdeci">VectorData * pData</div><div class="ttdoc">The container private information. </div><div class="ttdef"><b>Definition:</b> <a href="vector_8h_source.html#l00016">vector.h:16</a></div></div>
<div class="ttc" id="vector_8h_html_a04e4098bc20098fba01e057db43549a3"><div class="ttname"><a href="vector_8h.html#a04e4098bc20098fba01e057db43549a3">VectorSet</a></div><div class="ttdeci">int32_t VectorSet(Vector *self, Item item, int32_t iIdx)</div><div class="ttdoc">Set an item at the designated index of the vector. </div></div>
<div class="ttc" id="vector_8h_html_aebe9767f9216efa7efcd5d006ea47009"><div class="ttname"><a href="vector_8h.html#aebe9767f9216efa7efcd5d006ea47009">VectorCapacity</a></div><div class="ttdeci">int32_t VectorCapacity(Vector *self)</div><div class="ttdoc">Return the container capacity. </div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_e0f5f6345e438c73b9ae78ec2940718c.html">container</a></li><li class="navelem"><a class="el" href="vector_8h.html">vector.h</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
  </ul>
</div>
</body>
</html>
